home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 014 / libtools.arc / MODEM7.DQC / MODEM7.DOC
Encoding:
Text File  |  1984-04-20  |  12.0 KB  |  271 lines
  1.               CP/M MODEM PROGRAM DOCUMENTATION
  2.         by Mark M. Zeiger and James K. Mills
  3.               11/04/80
  4.         ( updated for "portable" version by BRK )
  5.  
  6. This  program  uses  the  file transfer routines  written  by  Ward 
  7. Christensen  in his CP/M file transfer program (V2.0 as of  8/6/79) 
  8. and  is  compatable with his program in single file transfer  mode. 
  9. Multi-file transfers are only possible between two systems  running 
  10. the program described below.
  11.  
  12. This program has two functions:
  13.  
  14.         1.  Communication
  15.         2.  Program transfer
  16.  
  17.  
  18. COMMUNICATIONS
  19.  
  20. The program may emulate a terminal or echo data back to sender (act
  21. as a computer).
  22.  
  23. Terminal Mode  -  'T' Option
  24.  
  25.         The  terminal mode may be called with or without a file  name. 
  26.         If  a  file  is  specified (it should be  a  new  file),  then 
  27.         anything  received  by the modem may be saved  in  memory  and 
  28.         later  written on disk.  The save feature is toggled ON/OFF by 
  29.         Control-Y.  A colon  (:) will be printed at the  beginning  of
  30.         each line when memory save is active.  The  colon will  not be
  31.         transmitted over the modem nor will it be saved in memory.
  32.  
  33.         If  a  file  is not specified,  then memory save  can  not  be 
  34.         activated.
  35.  
  36.         If  the memory buffer is full (the buffer is from the  top  of 
  37.         the program to the top of the segment ),   the  contents  are 
  38.         automatically  written  to  disk  (but the  file  is  not  yet 
  39.         closed).  Communications  may  then continue with  the  buffer 
  40.         reinitialized.  The  computer with which you are communicating 
  41.         must  accept  the  X-ON and X-OFF  (Control-Q  and  Control-S) 
  42.         conventions or data will be lost.
  43.  
  44.         When  communications are over,  use Control-E to exit from the 
  45.         Terminal  mode and enter the Menu.  The file to which you  are 
  46.         writing  must then be closed by using the  'WRT'  command.  If 
  47.         this  is  not done,  all data will be lost.  I decided not  to 
  48.         close  the file automatically since there will be  times  when 
  49.         you leave terminal mode and then decide to re-enter.  This may 
  50.         be done while in the Menu by using the 'RET' command.  You may 
  51.         re-enter Terminal mode and save in the same file as many times 
  52.         as  you wish as long as you have not closed the file with  the 
  53.         'WRT' command.
  54.  
  55.         While  in  Terminal  mode,  Control-T will  put  you  in  File 
  56.         Transfer mode.  This will allow you to send the contents of an 
  57.         ASCII file over the modem. This routine does no error checking 
  58.         and  there are no protocols specified between this program and 
  59.         the  receiving computer other than that it should be ready  to 
  60.         receive  data  via  the  modem.   Control-X  will  cancel  the 
  61.         transfer.
  62.  
  63.  
  64. Computer mode - 'E' Option
  65.  
  66.         This  mode  echos data received by other  computer.  Only  one 
  67.         computer  may be in this mode at one time.  There is  no  save 
  68.         feature  in this mode.  Useful if you wish to communicate with 
  69.         somebody running the terminal portion of the program.
  70.  
  71. File transfer - 'S' and 'R' Options
  72.  
  73.         These  features  are  the same as in the  CP/M  Modem  program 
  74.         written by Ward Christensen except that upon completion of the 
  75.         transfer, control returns to the Menu unless the secondary 'T' 
  76.         option has been selected.  In the latter case, control returns 
  77.         to Terminal mode.  Remember that if you are operating a remote 
  78.         computer   using   a  timesharing  program   (such   as   Ward 
  79.         Christensen's "BYE"),  the remote should be instructed to send 
  80.         or  receive  in  the  quiet (Q) mode as  a  secondary  option. 
  81.         Examples  of  commands for sending and  receiving  are  listed 
  82.         below.  You may also have to use the  quiet  mode  when  using
  83.         direct computer to computer  communication  at  speeds  higher
  84.         about  2400 baud because the console listing speed is too slow.
  85.  
  86.         The transmission protocol involves sending data in packets of
  87.         about 128 bytes along with an 8 bit checksum.  The receiving
  88.         system recomputes the checksum and compares it to one received.
  89.         If the checksums agree it sends back an acknowledgement character
  90.         and the sending system sends the next packet.  If the checksums
  91.         do not match, a negative acknowledge is sent and the sending
  92.         system automatically sends the packet again ( it will retry
  93.         at most 10 times before giving up ).
  94.  
  95. Multi-file transfers
  96.  
  97.         Using  the B (batch) secondary option,  more than one file and 
  98.         ambiguous filenames may be transferred. To send files, use the 
  99.         primary  option  "S" and the secondary option "B" (along  with 
  100.         any  other  secondary options and baudrate).  To  receive  the 
  101.         files  being  sent,  use the "R" primary option  and  the  "B" 
  102.         secondary  option.  Files may not be named since filenames are 
  103.         sent by the sending program, but a disk drive may be specified 
  104.         (or else the files are written to the default drive).
  105.  
  106. Backup option
  107.  
  108.         There  is  a byte at the beginning of the program (106H)  that 
  109.         will  create a backup file if a file on the disk has the  same 
  110.         name  as the file being received in multi-file  transfer  (see 
  111.         MODEM.SET). If this byte is set to 0FFH, a backup file will be 
  112.         created.  If  it is zero the file on the disk will be  deleted 
  113.         before the new file is received. If you are running CP/M 2 and 
  114.         a file on the disk is designated R/O or SYS,  a backup will be 
  115.         created whether the byte at 106H is set or not.
  116.  
  117.         Be  careful - if you are running CP/M 1 and the drive on which 
  118.         you  are receiving has an R/O file with the same name  created 
  119.         by CP/M 2,  the R/O file can not be accessed (found,  changed, 
  120.         erased,  etc.)  by CP/M 1.  You will therefore have two  files 
  121.         with  the same name when you are running CP/M 2.  To fix  this 
  122.         problem, use CP/M 1 to change the name of the file that is not 
  123.         R/O. Then use CP/M 2 to do what you want with the R/O file.
  124.  
  125.         Examples:   ( note in the examples that follow, Ignore the
  126.                   secondary  O  or  A commands as the portable
  127.                    version cannot set Originate or Answer mode- it
  128.               must be done manually on the modem)
  129.  
  130.         The  sender enters    SBOT.600 B:*.COM    to send all the  COM 
  131.         files on disk B.  Also specified were originate mode 600  baud 
  132.         (PMMI modem) and return to terminal mode when done.
  133.  
  134.         The  receiver enters     RBA.600    to receive all  the  files 
  135.         being  sent on the default drive.
  136.  
  137.  
  138.         The sender enters the command   SB.600  ASM.COM  *.HEX  B:M*.*
  139.         which  will send ASM.COM from the default drive,  all the  HEX 
  140.         files from the default drive,  and all the files starting with 
  141.         "M" from the B drive.  
  142.  
  143.         Multifile transfers may only be done from the menu. It may not 
  144.         be specified when the MODEM program is called.  In other words    
  145.         A>MODEM  SAB  *.COM   will result in an INVALID  OPTION  error 
  146.         message.
  147.  
  148.  
  149. Return to Menu - 'M' option
  150.  
  151.         When asked to select an option, 'M' returns to Menu.
  152.  
  153. The MENU
  154.  
  155.         If  the Modem program is entered with no option,  the Menu  is 
  156.         called.  The  Menu gives the choice of selecting the  standard 
  157.         options as defined by Ward Christensen (T,  E,  R, and S). The 
  158.         Terminal  mode has been greatly expanded as  described  above. 
  159.         The "R" and "S" commands must be called with a filename or you 
  160.         will be required to enter the primary command (S or R) and the 
  161.         filename  again (but NOT the secondary options).  If you  want 
  162.         multi-file  transfers,  then  the "R" option does not  need  a 
  163.         filename.
  164.  
  165.   RET - You may also enter terminal mode using the 'RET' command,  but 
  166.         no  data  will  be saved since a file may not  be  named  with 
  167.         'RET'.  Use  the 'RET' command to RE-ENTER Terminal mode after 
  168.         it  has  first been entered with the 'T' option.  If  this  is 
  169.         done, you will still be able to save the communications if you 
  170.         were doing so before you exitted the terminal mode.
  171.  
  172.   WRT - The  'WRT' command must be used after leaving  Terminal  mode. 
  173.         This  writes  the  last buffer to disk and  closes  the  file. 
  174.         Failure  to use the 'WRT' command results in loss of all  data 
  175.         and a file of length zero.
  176.  
  177.   DEL - The  'DEL'  command  erases the most recent file  accessed  in 
  178.         Terminal mode.  Useful if you decide after communications that 
  179.         you don't want to save information just gathered.
  180.  
  181.   DOS - The 'DOS' command reboots and returns to DOS.
  182.  
  183.   XPR - The  'XPR'  command is a toggle which causes the  menu  to  be 
  184.         printed  or not printed.  Initially the menu is on unless  the 
  185.         program is called with the "X" option (ie.  A>MODEM X ).
  186.  
  187.   DIR - The 'DIR' command lists the directory of a DOS disk.  A drive 
  188.         may  be specified (ie.  DIR B:) or the default drive  will  be 
  189.         listed.  After  the directory is listed,  the menu will not be 
  190.         printed whether XPR mode is on or off.  If XPR mode is on  and 
  191.         you wish to see the menu, hit return.
  192.  
  193.   ^B -  Control-B  while  in Terminal (or Echo) mode allows change  of 
  194.         baudrate "on-the-fly." A carriage return gives 300  baud;  all 
  195.         other rates (110-600) must be explicitely stated.
  196.  
  197.  
  198. LISTING OF COMMANDS AND OPTIONS
  199.  
  200.     Primary options
  201.  
  202.         S - send a CP/M file (must specify file/s)
  203.         R - receive  a CP/M file (must name file unless B sec opt used)
  204.         T - terminal mode (specify file if memory save wanted)
  205.         E - terminal mode with echo
  206.         M - return to menu
  207.         X - used only when program is called to initially
  208.             toggle menu off
  209.  
  210.     Secondary options
  211.  
  212.         B - multi-file mode for sending and receiving files
  213.         T - return to terminal mode after transfer (memory save off)
  214.         R - view what is received in file transfer
  215.         S - view what is being sent in file transfer
  216.         V - view what is being sent or received in file transfer
  217.         T - Terminal mode (used with remotely controlled computer)
  218.         O - originate mode -- NOT IMPLEMENTED IN PORTABLE VERSION --
  219.         A - answer mode        ""   ""
  220.         .xxx - baud rate xxx (xxx = 110-9600 for the serial port )
  221.  
  222. EXAMPLES        (fn = filename,  ft = filetype)
  223.  
  224.         Send file, originate mode, 300 baud
  225.  
  226.                                    SO fn.ft
  227.  
  228.         Send another file, same mode and baudrate
  229.  
  230.                                    S fn.ft
  231.  
  232.         Receive  file on B drive,  600 baud,  ans mode,  view what  is 
  233.         being received, return to terminal mode 
  234.  
  235.                                RART.600 B:fn.ft
  236.  
  237.         Send all COM files, no messages on console, same baud and mode 
  238.         as last transfer
  239.  
  240.                                   SBQ *.COM
  241.  
  242.         Send two files from two different drives
  243.  
  244.                            SB A:fn1.ft1  B:fn2.ft2
  245.  
  246.         Receive files being sent by above on drive A (baudrate must be 
  247.         same and modes opposite)
  248.  
  249.                                     RB A:
  250.  
  251.         Terminal mode,  save communication in file,  300 baud (default 
  252.         rate),  originate mode (in terminal must type CTRL-Y to  start 
  253.         save, in menu must type "WRT" to close file)
  254.  
  255.                                    TO fn.ft
  256.  
  257.  
  258.  
  259.         Any problems or bugs, please call me:
  260.  
  261.                 Or latest revisor:
  262.         Mark M. Zeiger        James K. Mills         Bruce R. Kendall
  263.         198-01B 67th Ave.    824 Jordan Place       Mt. View, Ca.
  264.         Flushing, N.Y. 11365    Rockford, IL  61108
  265.         (212) 454-6985        (815) 398-0579           415-967-3613
  266.  
  267.  
  268.  
  269.  
  270.  
  271.